Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d27 / cliup01.arc / CLISW.TXT < prev next >

Wrap

Text File | 1991-05-05 | 23KB | 545 lines

ESHEC Software Command Line Interface Table Of Contents I. Introduction ................................................. 1 II. Program Abstract ............................................. 1 What is CLI? ................................................. 1 What does CLI do for me? ..................................... 1 How do I install and startup CLI? ............................ 2 Some definitions before we begin ............................. 3 Notes ........................................................ 3 The CLI command line ......................................... 4 III. CLI Commands ................................................ 5 CLEAR ........................................................ 5 DEFINE ....................................................... 5 LOGICAL .................................................. 5 SYMBOL ................................................... 6 VERIFY ................................................... 6 DOS .......................................................... 6 EXIT (QUIT) .................................................. 6 GETFL (@) ................................................... 6 RECALL ....................................................... 6 SHOW ......................................................... 6 CORE ..................................................... 6 DATE ..................................................... 6 ENVIRONMENT .............................................. 6 LOGICAL .................................................. 7 SYMBOL ................................................... 7 TIME ..................................................... 7 VERSION .................................................. 7 SD ........................................................... 7 IV. Notes ......................................................... 8 V. Appendix A. Some examples ................................... 9 VI. Appendex B. CLI and DESQview ............................... 10 VII. Appendix C. CLI knows problems ............................. 11 Introduction Thank you for your interest in ESHEC Software. ESHEC software is a company committed to providing quality shareware software at reasonable prices. The software you have obtained is shareware. It is NOT freeware nor has it been placed in the public domain. We at ESHEC software believe in the shareware process and have thus made CLI available. You are granted a limited right to use license for a period of thirty days, after which time you must discontinue use or register. We hope you enjoy using CLI during your free trial period. If you like it, tell your friends, if not please tell us. What is CLI? CLI is a DOS Command Line Interface program that extends the capabili- ties of the DOS command line. CLI is NOT and was never intended to be a DOS shell program. If you are the type of PC user that almost never uses the DOS command line or are new to the PC then CLI can help you during the learning process. On the other hand, if you are an experienced user and find yourself frequently using DOS then the power of CLI shines. CLI was written because the developers at ESHEC, who are consultants and teachers in data processing, use DOS commands regularly when assisting clients and students. They were unable to find a command line enhancer that they liked - so they wrote their own. What does CLI do for me? CLI extends the DOS command line by providing: command line editing capabilities (both insert and overstrike toggled by the INSERT key), command line recall (using the up and down arrows or popup menu selection), command string pre-definitions with parameters, command chaining, logged device and working directory change, and program launching. You can also: add or remove directories from your current path, launch programs without starting another copy of COMMAND.COM, and terminate CLI at any time (CLI is NOT written as a TSR). CLI helps the new user to DOS by allowing you to customize DOS commands that you may find confusing or to complex to remember. CLI allows you to assign your own name to any DOS command. Every user of a DOS based machine will at sometime be faced with having to use DOS commands. While there are many great shell programs on the market that attempt to make this infrequent, the time will come that the only way out of a problem is to go down to the DOS level. The less you use something the more confusing its use becomes, that's where CLI comes in. By allowing you to associate your own names to commands, names which you are more likely to remember, this confusion is eliminated. CLI lets YOU make the choice. For example, suppose you need to format a low densi- ty 3.5" floppy in a high density drive. What is the DOS command to do that? Assume that your 3.5" drive is drive B one option is: FORMAT B: /n:9 /t:80 Who can possibly remember that?? (Never mind that, who would WANT to remember that??). Using CLI it is possible to give that entire command a name and from that point on, using the new name, CLI will know that you want to format a low density 3.5" floppy in high density drive B. When you get to the advanced options, you'll see that it is also possible to create generic names and specify options when you use them. The new names that you create are called SYMBOLS. We call them symbols because they are in effect synonyms for the actual commands. How do I install and startup CLI? CLI requires two files: CLISW.EXE Program file. CLISETUP.DAT File to hold command string pre-definitions. These two files should be on the distribution. If not, DO NOT USE the copy of CLI you have obtained and contact ESHEC Software. Copy both to the same directory. It may be any directory you wish, although we do recommend that it be included on your PATH statement. For example: COPY A:\CLI*.* C:\BIN If you have downloaded CLI from a BBS, CLI has been provided as an archive file. The two required files and this DOC file are all in the archive. To start CLI, simply type CLISW at the DOS command line and enjoy! Some definitions In order to use the full potential of CLI, you must understand some of the terms used through out this document and how CLI looks at these terms. 1. KEYWORD The portion of the command line CLI considers to be the command. The keyword is the sequence of characters on the command line until the first space is found. For example in the following string LI is considered the keyword: LI myfile.txt 2. SYMBOL A name given to a pre-defined character string. Symbols may be used in place of a keyword or may be used as part of the keyword parameters. 2. Logical A name given to a pre-defined character string that contains a device and directory path. Logical names may be used anywhere a device and directory path would be specified. 4. Parameter An object operated upon by the keyword. For example in the keyword example above, myfile.txt is the parameter. Other things worth noting: 1. Parameters are separated from their keywords by at least one space. 2. Parameters are separated from each other by at least one space. 3. When logical names are used in the parameter string (except on the SHOW command) they must be followed by a colon. For example: if C_BIN and D_BIN are logical names defined as c:\bin and d:\bin respectively, then in order to use the logical names in a DOS copy operation you would key the line as follows: > copy c_bin:myfile.txt d_bin:myfile.txt or > copy c_bin:myfile.txt d_bin (note no colon needed after d_bin in this example) 4. A symbol lookup is always done for keywords, therefore no special indication need be given to use a symbol as a command. 5. Symbols may also be defined as translating to a device and directory path, but symbol names may not be used in place of logical names. 6. Symbols values may be used in the parameter portion of the command line if the symbol name is enclosed in apostrophes. For example: if FL is a symbol that translates to c:\t\tc\bin\tc.exe, then the following command would copy c:\t\tc\bin\tc.exe to the current working directory: copy 'fl' The CLI command line CLI looks at the command line as two parts. The first part (delimited by a space) is called the keyword (or command) and the second part (the rest of the command line) is considered the parameters to the keyword. The logic CLI uses when processing a command, stated simply, is as follows: 1. Break command line into its parts (keyword and parameters) 2. Check if keyword is a symbol, if it is: replace keyword with the value of the symbol, search replaced value for parameter substitution characters and replace where necessary. 3. Scan parameter string for symbol substitution characters and replace where necessary. 4. Lookup keyword in internal command table, branch to internal command dispatcher if found, prompt again. 5. Pass entire command string to DOS, prompt again CLI also allows for command chaining when commands are entered on the command line. Multiple commands may be entered separating each with a semicolon. For example suppose you wanted to change your current working directory to EXPE- DITE on the current logged device and execute the batch file EXP.BAT in that directory. To do so you could key them as separate commands or key them as chained commands. First as separate commands: > cd \expedite > exp As Chained commands: > cd \expedite;exp CLI Internal Commands The commands in this section are all processed by CLI internally. Gener- ally you need not spell out an entire internal command in order to get CLI to execute it. Only the number of characters needed to make the command unique need be specified. For example, to distinguish between the DEFINE and DOS commands, you would need to specify DE for DEFINE and DO for DOS, whereas you need only specify C for the CLEAR command because it is currently the only internal command that begins with an C. We do not recommend using abbrevia- tions in command definition files as future releases of CLI may include new internal commands that would cause your abbreviations to no longer be unique. CLEAR CLEAR Clear Clears the screen and displays the running banner on line one. DEFINE DEFINE <option> <parameters> DEFINE LOGICAL BIN C:\PGMS\BIN Define entity (logical name or symbol) to CLI or set value of flag. The option portion of this command is also a keyword and may be abbreviated as discussed above. The above example of defining the logical name BIN could have been typed as: DE L BIN C:\PGMS\BIN. Logical names are generally used as short hand for device and path specifications, similar in function to the DOS SUBST command. Symbols are generally used as short hand for DOS command strings. Symbols also allow for recognition and parameter substitution. The best way to explain what this means is by example. Suppose you wanted to define a symbol that would allow you to type the contents of a DOS file to the screen with pagination. How would you do it? First, the DOS command to do this is: TYPE myfile.txt | MORE. By defining a symbol to CLI we can do this much more simply. Choosing the name LIST for our symbol, LIST should be defined as follows: DEFINE SYMBOL LI*ST TYPE % | MORE Then, to type myfile.txt to the screen with pagination, we simply type LI myfile.txt on the command line. Note the use of the asterisk in the LIST symbol definition. A asterisk is used to tell CLI that you want CLI to recognize the symbol when you type the characters that precede it. Therefore when you type LI, LIS, or LIST, CLI will recognize it as your LIST symbol. Also note the use of the percent sign in the definition. Percent signs are used to denote parameter substitutions. CLI will replace the first percent sign with the first parameter, the second with the second and so on. DEFINE LOGICAL <name> <translation> DEFINE LOGICAL BIN C:\PGMS\BIN DEFINE SYMBOL <name> <translation> DEFINE SYMBOL TY TYPE DEFINE VERIFY <ON|OFF> DEFINE VERIFY ON If on, echo commands. DOS DOS Spawn to DOS EXIT EXIT|QUIT EXIT Terminate CLI and returns to DOS GETFL GETFL <file name> GETFL CLISETUP.DAT @CLISETUP.DAT Read and process CLI commands in file <file name>. The file specified to the GETFL command contains CLI commands one command per line. Spacing is not important other than if a space is required such as between keywords and parameters, then at least one must be used. You may use an exclamation point at any time to denote a comment. All text following the exclamation point is ignored. RECALL RECALL Use the RECALL command to popup a menu of the last 20 entered commands. Select one by using the up and down arrow keys to highlight your selection and press return. The selected command will appear on the command line and may be edited prior to executing it. If you depress ESC while the popup menu is displayed, no command is selected and the popup window is closed. SHOW SHOW <what> <options> SHOW LOGICAL BIN SHOW CORE Show heap bytes remaining. SHOW DATE Show Current date and time SHOW ENVIRONMENT Show current DOS environmental variables (established with DOS SET command) SHOW LOGICAL <name> SHOW LOGICAL BIN SHOW LOGICAL Show translation of specified logical name. If no name is specified all currently defined logical names will be shown. SHOW SYMBOL <name> SHOW SYMBOL TY SHOW SYMBOL Show translation of specified symbol. If no name is specified all currently defined symbols will be shown. SHOW TIME Show current date and time. SHOW VERSION Show current CLI version. SD SD <logical|path> SD BIN SD stands for 'set default'. The SD command will set your current logged device and working directory to the path specified by its parameter. NOTES o CLI traps and processes the following three DOS commands: CD, PROMPT, and SET. The functionality is the same as provided by DOS. o At any time CLI is prompting for a command, you may use the up and down arrow keys to recall up to the twenty previously entered commands. You may toggle between edit insert or overstrike mode my pressing the INSERT key. o If command chaining is used on the command line, the entire line is placed in the recall area. As each command is processed it is also stacked for recall. This allows the entire sequence to be recalled or any one of the pieces. o When CLI is exited, the DOS environment is restored to what it was prior to CLI being invoked. Therefore the changes made by any SET, PROMPT, APATH, or RPATH commands will be lost. Appendix A. Some Examples It is possible to combine some of the features discussed through out this manual to create a DOS environment that is unique to you. Listed here are some of the symbol definitions and logical names that the developers at ESHEC use. Although we have included some very specific examples this of course is not our complete list because ours, just as yours will become to you, is unique to us. Command Logical Name Equivalence DEFINE LOGICAL DOS C:\DOS DEFINE LOGICAL PARA*DOX3 C:\PARADOX3 DEFINE LOGICAL PCTOOLS D:\PCTOOLS DEFINE LOGICAL PCPLUS C:\UTIL\PCPLUS DEFINE LOGICAL TC C:\T\TC\BIN DEFINE LOGICAL TOPC C:\ DEFINE LOGICAL TOPD D:\ DEFINE LOGICAL EDT$ C:\UTIL\EDTV5 DEFINE LOGICAL ZIP$ C:\UTIL\PZK110 Command Symbol Name Equivalence DEFINE SYMBOL BKUP PCTOOLS:PCBACKUP.EXE DEFINE SYMBOL CAT DIR % | SORT | MORE DEFINE SYMBOL EDIT EDT$:EDT.EXE DEFINE SYMBOL EDT 'EDIT' DEFINE SYMBOL ER*ASE ERASE DEFINE SYMBOL GO SD DEFINE SYMBOL GREP TC:GREP.COM DEFINE SYMBOL LI*ST TYPE % | MORE DEFINE SYMBOL LH*ARC C:\UTIL\LHARC\LHARC DEFINE SYMBOL LN SHOW LOGICAL DEFINE SYMBOL PA*GE 'LI' DEFINE SYMBOL PCP*LUS PCPLUS:PCPLUS.EXE DEFINE SYMBOL SEA*RCH 'GREP' -i+ -n+ DEFINE SYMBOL SS SHOW SYMBOL DEFINE SYMBOL UNZIP ZIP$:PKUNZIP.EXE Appendix B. CLI and DESQview CLI will only run in a small DESQview window on 386 (also SX), and 486 machines. 286 and 80x8 machines running DV must execute CLI in a full screen window. Although CLI was written to be DV aware, full functionality was not provided in the Shareware version. Please note however that at no time does CLI attempt to compensate for 'ill' behaved programs in a DESQview environ- ment. Most often, users of CLI and DV will use CLI in lieu of DV's big DOS window. Appendix C. CLI Known problems In this section we will try to answer some of the questions that have already been posed to the CLI developers and identify some of CLI idiosyncra- sies. 1. Why does CLI take up so much memory? We know that the CLI program take more memory than some would like. As CLI was developed as an in-house tool for us, size didn't much matter. We were more concerned with convenience and speed. If CLI is accepted by the PC community, one of our first efforts in a future release of the registered version will be to reduce its memory requirements. 2. Why can't I use command chaining in a symbol definition? Currently command chaining is provided only on the command line. It is our intent in a future release of the register version of CLI to provide chaining functionality in symbols, thereby allowing a symbol to act as a mini batch file. 3. What is CLI written in? CLI is written entirely in Borland C. Borland's BORLAND C++ compiler is used to build the CLI executable. 4. What does CLI use to access the video screen? CLI writes directly to video memory for all of its own output by using BORLAND C's video routines. This allows for the fastest possible screen displays and the prompt string to contain ANSI escape sequences. Of course if you do use the $E in your prompt, then ANSI.SYS must be loaded. (Note: the registered version allows you to specify BIOS video) 5. Does CLI change my AUTOEXEC.BAT or CONFIG.SYS files? No. CLI makes no attempt to change either of these. 6. Does CLI do any special interrupt handling? No. CLI makes no attempt to control any of the PC's interrupts. Nor does it do any interrupt trapping. 7. Can I use the function keys with CLI? Not at this time. We anticipate providing this option in a future release of the registered version of CLI. 8. Can I change CLI's use of color? Yes. However this option is provided only in the registered version. 9. Can I remove CLI's signature at the beginning of the prompt? Yes. However this option is provided only in the registered version. 10. Can I change the size of the recall stack? Not at this time. We anticipate providing this option in a future release of the registered version of CLI. 11. Can I have CLI automatically load my setup when it starts? Yes. CLI will look in the directory it was started from for a file CLISETUP.DAT. If found, CLI will issue a: GETFL CLISETUP.DAT for you. 12. How do I become a registered user and what do I get? Read the file REGISTER.TXT included on the distribution.